home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / PRODUCTCONTEXT.PY < prev    next >
Encoding:
Python Source  |  2000-11-20  |  13.7 KB  |  357 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. """Objects providing context for product initialization
  86. """
  87. from AccessControl.PermissionRole import PermissionRole
  88. import Globals, os, OFS.ObjectManager, OFS.misc_, Products
  89. import AccessControl.Permission
  90. from HelpSys import HelpTopic, APIHelpTopic
  91. from HelpSys.HelpSys import ProductHelp
  92. from FactoryDispatcher import FactoryDispatcher
  93. from zLOG import LOG, WARNING
  94. import string, os.path
  95. import stat
  96. from DateTime import DateTime
  97.  
  98. import ZClasses # to enable 'PC.registerBaseClass()'
  99.  
  100. if not hasattr(Products, 'meta_types'): Products.meta_types=()
  101. if not hasattr(Products, 'meta_classes'):
  102.     Products.meta_classes={}
  103.     Products.meta_class_info={}
  104.  
  105. class ProductContext:
  106.  
  107.     def __init__(self, product, app, package):
  108.         self.__prod=product
  109.         self.__app=app
  110.         self.__pack=package
  111.  
  112.     def registerClass(self, instance_class=None, meta_type='', 
  113.                       permission=None, constructors=(),
  114.                       icon=None, permissions=None, legacy=(),
  115.         ):
  116.         """Register a constructor
  117.  
  118.         Keyword arguments are used to provide meta data:
  119.  
  120.         instance_class -- The class of the object that will be created.
  121.         
  122.           This is not currently used, but may be used in the future to
  123.           increase object mobility.
  124.  
  125.         meta_type -- The kind of object being created
  126.            This appears in add lists.  If not specified, then the class
  127.            meta_type will be used.
  128.  
  129.         permission -- The permission name for the constructors.
  130.            If not specified, then a permission name based on the
  131.            meta type will be used.
  132.  
  133.         constructors -- A list of constructor methods
  134.           A method can me a callable object with a __name__
  135.           attribute giving the name the method should have in the
  136.           product, or the method may be a tuple consisting of a
  137.           name and a callable object.  The method must be picklable.
  138.  
  139.           The first method will be used as the initial method called
  140.           when creating an object.
  141.  
  142.         icon -- The name of an image file in the package to
  143.                 be used for instances. Note that the class icon
  144.                 attribute will be set automagically if an icon is
  145.                 provided.
  146.  
  147.         permissions -- Additional permissions to be registered
  148.            If not provided, then permissions defined in the
  149.            class will be registered.
  150.         
  151.         legacy -- A list of legacy methods to be added to ObjectManager
  152.                   for backward compatibility
  153.  
  154.         """
  155.         app=self.__app
  156.         pack=self.__pack
  157.         initial=constructors[0]
  158.         tt=type(())
  159.         productObject=self.__prod
  160.         pid=productObject.id
  161.  
  162.         if icon and instance_class is not None:
  163.             setattr(instance_class, 'icon', 'misc_/%s/%s' %
  164.                     (pid, os.path.split(icon)[1]))
  165.  
  166.         OM=OFS.ObjectManager.ObjectManager
  167.  
  168.         if permissions:
  169.             for p in permissions:
  170.                 if type(p) is tt:
  171.                     p, default= p
  172.                     AccessControl.Permission.registerPermissions(
  173.                         ((p, (), default),))
  174.                 else:
  175.                     AccessControl.Permission.registerPermissions(
  176.                         ((p, ()),))
  177.  
  178.         ############################################################
  179.         # Constructor permission setup
  180.         if permission is None:
  181.             permission="Add %ss" % (meta_type or instance_class.meta_type)
  182.  
  183.         if type(permission) is tt:
  184.             permission, default = permission
  185.         else:
  186.             default = ('Manager',)
  187.  
  188.         pr=PermissionRole(permission,default)
  189.         AccessControl.Permission.registerPermissions(
  190.             ((permission, (), default),))
  191.         ############################################################
  192.  
  193.         for method in legacy:
  194.             if type(method) is tt: name, method = method
  195.             else: name=method.__name__
  196.             if not OM.__dict__.has_key(name):
  197.                 setattr(OM, name, method)
  198.                 setattr(OM, name+'__roles__', pr)
  199.  
  200.         if type(initial) is tt: name, initial = initial
  201.         else: name=initial.__name__
  202.  
  203.         fd=getattr(pack, '__FactoryDispatcher__', None)
  204.         if fd is None:
  205.             class __FactoryDispatcher__(FactoryDispatcher):
  206.                 "Factory Dispatcher for a Specific Product"
  207.  
  208.             fd = pack.__FactoryDispatcher__ = __FactoryDispatcher__
  209.  
  210.         if not hasattr(pack, '_m'): pack._m=fd.__dict__
  211.         m=pack._m
  212.  
  213.         Products.meta_types=Products.meta_types+(
  214.             { 'name': meta_type or instance_class.meta_type,
  215.               'action': ('manage_addProduct/%s/%s' % (pid, name)),
  216.               'product': pid,
  217.               'permission': permission,
  218.               },)
  219.  
  220.         m[name]=initial
  221.         m[name+'__roles__']=pr
  222.  
  223.         for method in constructors[1:]:
  224.             if type(method) is tt: name, method = method
  225.             else:
  226.                 name=os.path.split(method.__name__)[-1]
  227.             if not productObject.__dict__.has_key(name):
  228.                 m[name]=method
  229.                 m[name+'__roles__']=pr
  230.  
  231.         if icon:
  232.             name=os.path.split(icon)[1]
  233.             icon=Globals.ImageFile(icon, self.__pack.__dict__)
  234.             icon.__roles__=None
  235.             if not hasattr(OFS.misc_.misc_, pid):
  236.                 setattr(OFS.misc_.misc_, pid, OFS.misc_.Misc_(pid, {}))
  237.             getattr(OFS.misc_.misc_, pid)[name]=icon
  238.  
  239.  
  240.     def registerZClass(self, Z, meta_type=None):
  241.         #
  242.         #   Convenience method, now deprecated -- clients should
  243.         #   call 'ZClasses.createZClassForBase()' themselves at
  244.         #   module import time, passing 'globals()', so that the
  245.         #   ZClass will be available immediately.
  246.         #
  247.         base_class=Z._zclass_
  248.         if meta_type is None:
  249.             if hasattr(base_class, 'meta_type'): meta_type=base_class.meta_type
  250.             else:                                meta_type=base_class.__name__
  251.  
  252.         module=base_class.__module__
  253.         name=base_class.__name__
  254.             
  255.         key="%s/%s" % (module, name)
  256.  
  257.         if module[:9]=='Products.': module=string.split(module,'.')[1]
  258.         else: module=string.split(module,'.')[0]
  259.             
  260.         info="%s: %s" % (module, name)
  261.  
  262.         Products.meta_class_info[key]=info # meta_type
  263.         Products.meta_classes[key]=Z
  264.         
  265.         
  266.  
  267.     def registerBaseClass(self, base_class, meta_type=None):
  268.         #
  269.         #   Convenience method, now deprecated -- clients should
  270.         #   call 'ZClasses.createZClassForBase()' themselves at
  271.         #   module import time, passing 'globals()', so that the
  272.         #   ZClass will be available immediately.
  273.         #
  274.         Z = ZClasses.createZClassForBase( base_class, self.__pack )
  275.         return Z
  276.  
  277.  
  278.     def getProductHelp(self):
  279.         """
  280.         Returns the ProductHelp associated with the current Product.
  281.         """
  282.         return self.__prod.__of__(self.__app.Control_Panel.Products).getProductHelp()
  283.  
  284.     def registerHelpTopic(self, id, topic):
  285.         """
  286.         Register a Help Topic for a product.
  287.         """
  288.         self.getProductHelp()._setObject(id, topic)
  289.  
  290.     def registerHelpTitle(self, title):
  291.         """
  292.         Sets the title of the Product's Product Help
  293.         """
  294.         h = self.getProductHelp()
  295.         if getattr(h, 'title', None) != title:
  296.             h.title = title
  297.  
  298.     def registerHelp(self, directory='help', clear=1):
  299.         """
  300.         Registers Help Topics for all objects in a directory.
  301.  
  302.         Nothing will be done if the files in the directory haven't
  303.         changed since the last registerHelp call.
  304.  
  305.         'clear' indicates whether or not to delete all existing
  306.         Topics from the Product.
  307.  
  308.         HelpTopics are created for these kind of files
  309.  
  310.         .dtml            -- DTMLHelpTopic
  311.         .html .htm       -- TextHelpTopic        
  312.         .stx .txt        -- STXHelpTopic
  313.         .jpg .png .gif   -- ImageHelpTopic
  314.         .py              -- APIHelpTopic
  315.         """
  316.         help=self.getProductHelp()
  317.         path=os.path.join(Globals.package_home(self.__pack.__dict__),
  318.                           directory)
  319.  
  320.         # If help directory does not exist, log a warning and return.
  321.         try:
  322.             dir_mod_time=DateTime(os.stat(path)[stat.ST_MTIME])
  323.         except OSError, (errno, text):
  324.             LOG("Zope", WARNING, '%s: %s' % (text, path))
  325.             return
  326.  
  327.         # test to see if nothing has changed since last registration
  328.         if help.lastRegistered is not None and \
  329.                 help.lastRegistered >= dir_mod_time:
  330.             return
  331.         help.lastRegistered=DateTime()
  332.  
  333.         if clear:
  334.             for id in help.objectIds('Help Topic'):
  335.                 help._delObject(id)
  336.  
  337.         for file in os.listdir(path):
  338.             ext=os.path.splitext(file)[1]
  339.             ext=string.lower(ext)
  340.             if ext in ('.dtml',):
  341.                 ht=HelpTopic.DTMLTopic(file, '', os.path.join(path,file))
  342.                 self.registerHelpTopic(file, ht)
  343.             elif ext in ('.html', '.htm'):
  344.                 ht=HelpTopic.TextTopic(file, '', os.path.join(path,file))
  345.                 self.registerHelpTopic(file, ht)
  346.             elif ext in ('.stx', '.txt'):
  347.                 title=string.split(open(os.path.join(path,file),'rb').readline(), ':')[0]
  348.                 ht=HelpTopic.STXTopic(file, title, os.path.join(path, file))
  349.                 self.registerHelpTopic(file, ht)
  350.             elif ext in ('.jpg', '.gif', '.png'):
  351.                 ht=HelpTopic.ImageTopic(file, '', os.path.join(path, file))
  352.                 self.registerHelpTopic(file, ht)
  353.             elif ext in ('.py',):
  354.                 ht=APIHelpTopic.APIHelpTopic(file, '', os.path.join(path, file))
  355.                 self.registerHelpTopic(file, ht)
  356.             
  357.